Skip to content

feat(astro,nuxt,react-router,tanstack-react-start): Env-var to suppress dev keys warning#8402

Merged
jacekradko merged 7 commits intomainfrom
jacek/suppress-dev-keys-warning-env-vars
May 1, 2026
Merged

feat(astro,nuxt,react-router,tanstack-react-start): Env-var to suppress dev keys warning#8402
jacekradko merged 7 commits intomainfrom
jacek/suppress-dev-keys-warning-env-vars

Conversation

@jacekradko
Copy link
Copy Markdown
Member

@jacekradko jacekradko commented Apr 25, 2026

Summary

Adding a convention based env variable to our framework SDKs to allow for easier disabling of the dev mode warning.

Resolves: SDK-74

The unsafe_disableDevelopmentModeConsoleWarning option has shipped on <ClerkProvider> for a while, but until now Next.js was the only framework integration with an env-var shortcut. This PR brings the same convenience to Astro, Nuxt, React Router, and TanStack Start so the development-keys warning can be suppressed without threading the option through <ClerkProvider> manually.

  • Astro: PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING
  • Nuxt: NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING
  • React Router: VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING (or unprefixed)
  • TanStack Start: VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING (or unprefixed)

The JSDoc on unsafe_disableDevelopmentModeConsoleWarning now lists every framework's env-var shortcut and notes that suppressing the warning at source also keeps it from being mirrored into the dev-server terminal (e.g. Next.js with experimental.browserDebugInfoInTerminal).

The wiring follows each framework's existing pattern:

  • Astro reads from import.meta.env inside mergeEnvVarsWithParams, mirroring how PUBLIC_CLERK_* vars already flow into Clerk.load().
  • Nuxt declares the key explicitly in the public runtime config so the NUXT_PUBLIC_CLERK_* override convention picks it up; the existing ...clerkConfig spread carries it through to the Vue plugin.
  • TanStack Start reads it via getPublicEnvVariables/mergeWithPublicEnvs, the same path used for other client-readable vars (Vite exposes VITE_* to the browser bundle).
  • React Router reads it via getPublicEnvVariables, packs it into the SSR clerkState payload as __unsafeDisableDevelopmentModeConsoleWarning, and unpacks it in ReactRouterClerkProvider.

Test plan

  • pnpm turbo build --filter=@clerk/shared --filter=@clerk/astro --filter=@clerk/nuxt --filter=@clerk/tanstack-react-start --filter=@clerk/react-router passes
  • In an Astro app with development keys, set PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING=true and confirm the console warning is suppressed
  • In a Nuxt app, set NUXT_PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING=true and confirm the warning is suppressed
  • In a TanStack Start app, set VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING=true and confirm the warning is suppressed
  • In a React Router (SSR) app, set VITE_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING=true and confirm the warning is suppressed
  • Confirm passing the option directly to <ClerkProvider unsafe_disableDevelopmentModeConsoleWarning /> still works in each framework

…r shortcut for unsafe_disableDevelopmentModeConsoleWarning
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 25, 2026

🦋 Changeset detected

Latest commit: 5990d02

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 20 packages
Name Type
@clerk/astro Minor
@clerk/nuxt Minor
@clerk/react-router Minor
@clerk/tanstack-react-start Minor
@clerk/shared Patch
@clerk/backend Patch
@clerk/chrome-extension Patch
@clerk/clerk-js Patch
@clerk/expo-passkeys Patch
@clerk/expo Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/hono Patch
@clerk/localizations Patch
@clerk/msw Patch
@clerk/nextjs Patch
@clerk/react Patch
@clerk/testing Patch
@clerk/ui Patch
@clerk/vue Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 25, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment May 1, 2026 1:20am

Request Review

@jacekradko jacekradko changed the title feat(astro,nuxt,react-router,tanstack-react-start): Env-var shortcut for unsafe_disableDevelopmentModeConsoleWarning feat(astro,nuxt,react-router,tanstack-react-start): Env-var to suppress dev keys warning Apr 25, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 59a99922-4990-45ec-a737-19ec342c11c2

📥 Commits

Reviewing files that changed from the base of the PR and between aa44f47 and 34e4626.

📒 Files selected for processing (1)
  • integration/testUtils/machineAuthHelpers.ts
💤 Files with no reviewable changes (1)
  • integration/testUtils/machineAuthHelpers.ts

📝 Walkthrough

Walkthrough

Adds an opt-out flag for the development-mode console warning across multiple Clerk integrations (Astro, Nuxt, React Router, TanStack Start). Changes include a new changeset documenting framework-specific env var shortcuts, reading/merging of the new flag from public envs into runtime/init state, type extensions for internal Clerk state, and unit tests validating precedence and hydration from env vars.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 40.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: adding environment variable shortcuts across multiple frameworks to suppress the development keys warning.
Description check ✅ Passed The description is detailed and directly related to the changeset, explaining the purpose, implementation approach per framework, and providing test plan steps.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Review rate limit: 4/5 reviews remaining, refill in 12 minutes.

Comment @coderabbitai help to get the list of available commands and usage tips.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 25, 2026

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@8402

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@8402

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@8402

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@8402

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@8402

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@8402

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@8402

@clerk/express

npm i https://pkg.pr.new/@clerk/express@8402

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@8402

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8402

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@8402

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@8402

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@8402

@clerk/react

npm i https://pkg.pr.new/@clerk/react@8402

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@8402

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@8402

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@8402

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@8402

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8402

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@8402

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@8402

commit: 5990d02

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@packages/astro/src/internal/merge-env-vars-with-params.ts`:
- Around line 69-71: The boolean precedence bug: change the fallback logic for
unsafe_disableDevelopmentModeConsoleWarning so an explicit false passed via
paramUnsafeDisableDevelopmentModeConsoleWarning is not overridden by the env
value; locate the unsafe_disableDevelopmentModeConsoleWarning assignment and
replace the use of || (which treats false as unset) with a nullish-coalescing or
explicit undefined check (e.g., use ?? or check
paramUnsafeDisableDevelopmentModeConsoleWarning !== undefined) to prefer the
provided parameter when it's false and only use
import.meta.env.PUBLIC_CLERK_UNSAFE_DISABLE_DEVELOPMENT_MODE_CONSOLE_WARNING
when the parameter is nullish/undefined.

In `@packages/tanstack-react-start/src/client/utils.ts`:
- Around line 80-81: The merge for unsafe_disableDevelopmentModeConsoleWarning
currently uses the || operator so a deliberate false in restInitState is treated
as absent; change the fallback to use nullish coalescing (??) when computing
unsafe_disableDevelopmentModeConsoleWarning so that only null/undefined fall
back to envVars.unsafeDisableDevelopmentModeConsoleWarning, preserving explicit
false values in restInitState and envVars.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: be5871bc-f61d-4083-b137-7f19f771aae2

📥 Commits

Reviewing files that changed from the base of the PR and between 2f48ea8 and f7e9f93.

📒 Files selected for processing (10)
  • .changeset/quiet-dev-keys-warning.md
  • packages/astro/src/internal/merge-env-vars-with-params.ts
  • packages/nuxt/src/module.ts
  • packages/react-router/src/client/ReactRouterClerkProvider.tsx
  • packages/react-router/src/client/types.ts
  • packages/react-router/src/server/utils.ts
  • packages/react-router/src/utils/env.ts
  • packages/shared/src/types/clerk.ts
  • packages/tanstack-react-start/src/client/utils.ts
  • packages/tanstack-react-start/src/utils/env.ts

Comment thread packages/astro/src/internal/merge-env-vars-with-params.ts
Comment thread packages/tanstack-react-start/src/client/utils.ts Outdated
Copy link
Copy Markdown
Member

@wobsoriano wobsoriano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes finally

@jacekradko jacekradko merged commit 90beaeb into main May 1, 2026
43 checks passed
@jacekradko jacekradko deleted the jacek/suppress-dev-keys-warning-env-vars branch May 1, 2026 01:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants